feat: Split statistics components computation & output by MelReyCG · Pull Request #3836 · GEOS-DEV/GEOS

MelReyCG · 2025-09-26T15:08:30Z

Issue: #3822
On top of PR : #3829

Planned refactor: The goal is to have a way to query statistics for solver (reservoir reference pressure for wells), with a clear separation with output statistics component.

The solution proposed here aims at giving a single data storage for each component needing statistics computation. In practices, the statistics are no longer recomputed for each convergence step, but only once, at start of each iteration (it gives the same result since the operation is read only).

To achieve these goals, the PR propose to separate each roles, instead of having everything in each *PhaseStatistics class:

RegionStatistics classes for resulting data storages at different levels:
- sub-regions mpi-local kernel compute read-backs,
- (cell element) regions,
- solver discretisation MeshLevel,
StatsAggregator classes to compute & reduce the statistics to rank 0, can be instanciated as solver helpers (as done for wells in the PR),
StatsTask Group, the user component to schedule flow statistics computation & output to log & CSV.

Old stats data architecture (stats are sticked to regions, and shared by all components):

Problem : ProblemManager
|-> domain : DomainPartition
    |-> MeshBodies : Group
        |-> cartesianMesh : MeshBody
            |-> meshLevels : Group
                |-> Level0 : MeshLevel
                |   |-> nodeManager : NodeManager
                |   |   |  * RegionStatistics (aggregate, mpi reduced)  <- stats data
                |   |   |-> sets : Group
                |   |       | * all : Wrapper< index array >
                |   |       | * xneg : Wrapper< index array >
                |   |       [...] (other element sets)
                |   |
                |   |-> ElementRegions : ElementRegionManager
                |   |   |  * RegionStatistics (aggregate, mpi reduced)  <- stats data
                |   |   |-> Channel : CellElementRegion
                |   |   |   |-> cb-0_0_0 : CellElementSubRegion
                |   |   |   |   | * pressure : Wrapper< real64 array >
                |   |   |   |   | * temperature : Wrapper< real64 array >
                |   |   |   |   | * RegionStatistics (compute read-back)  <- stats data
                |   |   |   |   [...] (other fields)
                |   |   |   |
                |   |   |   |-> cb-0_0_1 : CellElementSubRegion
                |   |   |   |   | * pressure : Wrapper< real64 array >
                |   |   |   |   | * temperature : Wrapper< real64 array >
                |   |   |   |   | * RegionStatistics (compute read-back)  <- stats data
                |   |   |   |   [...] (other fields)
                |   |   |   |
                |   |   |   [...] (other sub-regions)
                |   |   |
                |   |   |-> Barrier : CellElementRegion
                |   |       |-> cb-1_0_0 : CellElementSubRegion
                |   |       |-> cb-1_0_1 : CellElementSubRegion
                |   |       |-> * RegionStatistics (compute read-back)  <- stats data
                |   |       [...] (other sub-regions)
                |   |
                |   [...] (other element managers)
                |
                [...] (other discretizations)

Proposed new way, with a clear storage for each aggregator instance:

Problem : ProblemManager
|-> domain : DomainPartition
    |-> MeshBodies : Group
        |-> cartesianMesh : MeshBody
            |-> meshLevels : Group
                |-> Level0 : MeshLevel
                |   |-> nodeManager : NodeManager
                |   |   |-> sets : Group
                |   |       | * all : Wrapper< index array >
                |   |       | * xneg : Wrapper< index array >
                |   |       [...] (other element sets)
                |   |
                |   |-> ElementRegions : ElementRegionManager
                |   |   |-> Channel : CellElementRegion
                |   |   |   |-> cb-0_0_0 : CellElementSubRegion
                |   |   |   |   | * pressure : Wrapper< real64 array >
                |   |   |   |   | * temperature : Wrapper< real64 array >
                |   |   |   |   [...] (other fields)
                |   |   |   |
                |   |   |   |-> cb-0_0_1 : CellElementSubRegion
                |   |   |   |   | * pressure : Wrapper< real64 array >
                |   |   |   |   | * temperature : Wrapper< real64 array >
                |   |   |   |   [...] (other fields)
                |   |   |   |
                |   |   |   [...] (other sub-regions)
                |   |   |
                |   |   |-> Barrier : CellElementRegion
                |   |       |-> cb-1_0_0 : CellElementSubRegion
                |   |       |-> cb-1_0_1 : CellElementSubRegion
                |   |       [...] (other sub-regions)
                |   |
                |   [...] (other element managers)
         ____   |   |
         |      |   |-> statistics : Group (storage for all stats)
         |      |       |-> flowStats : Group (storage for this instance stats)
         |      |       |   |-> regionsStatistics : RegionStatistics (aggregate)
         |      |       |       |-> Channel : RegionStatistics (aggregate, mpi reduced)
         |      |       |       |   |-> cb-0_0_0 : RegionStatistics (compute read-back)
 stats   |      |       |       |   |-> cb-0_0_1 : RegionStatistics (compute read-back)
 data -> |      |       |       |   [...] (other sub-regions stats)
         |      |       |       |
         |      |       |       |-> Barrier : RegionStatistics (aggregate, mpi reduced)
         |      |       |           |-> cb-1_0_0 : RegionStatistics (compute read-back)
         |      |       |           |-> cb-1_0_1 : RegionStatistics (compute read-back)
         |      |       |           [...] (other sub-regions stats)
         |      |       |
         |___   |       [...] (other stats storages)
                |
                [...] (other discretizations)

Decoupling the storage of the CellElementRegion will help to provide a way of obtaining statistics from arbitrary mesh regions (defined by sets for instance).

PR also propose to consolidate testFlowStatistics by also checking the total mass balance of the compositional cases.

…ttps://github.com/amandinehry/GEOS into feature/amandinehry/create-yaml-file-and-structure

…hry/create-yaml-file-and-structure

… created first

…rser.h modifications since no longer useful

…sts by feature

…y/create-yaml-file-and-structure

…ttps://github.com/amandinehry/GEOS into feature/amandinehry/create-yaml-file-and-structure

…mandinehry/create-yaml-file-and-structure

…t-test + testing GEOS_ERROR

…unit test separation for multiple EXPECT_EXIT

…upported by fmt for now)

tjb-ltk · 2026-03-09T14:25:46Z

src/coreComponents/common/format/table/TableFormatter.hpp

What is a PreparedTableLayout vs presumably an "non" PreparedTableLayout

The TableLayout is the descriptor of the desired layout, and the PreparedTableLayout has precomputed data for optimizing further ascii formatting.

does that answer?

tjb-ltk · 2026-03-09T14:30:44Z

src/coreComponents/physicsSolvers/fluidFlow/unitTests/testFlowStatistics.cpp

Why is this in the getTotalFluidMass function and not inside the region stats... could we get rid of the specializations at the getter level...

…nformation)

…tatistics-components

MelReyCG · 2026-03-11T15:15:20Z

Verified that rebaselining is safe: purely structural, no numerical difference.

…tatistics-components

MelReyCG · 2026-03-13T16:43:50Z

I'm removing all the CUDA & integrated tests runs until people review this PR, but they ran succesfully.

amandinehry and others added 30 commits July 21, 2025 11:00

Merge branch 'feature/amandinehry/create-yaml-file-and-structure' of h…

127f38e

…ttps://github.com/amandinehry/GEOS into feature/amandinehry/create-yaml-file-and-structure

Merge remote-tracking branch 'upstream/develop' into feature/amandine…

e9508f5

…hry/create-yaml-file-and-structure

🔊 warn the deveveloppers that a yamlFile should not be written if not…

7fc0ced

… created first

🐛 ⏪ set the --errorsOutput mandatory because of bug + revert optionpa…

35f7686

…rser.h modifications since no longer useful

✏️ typo

31842a5

🎨 uncrustify

a1105e4

🎨 docs alignement

c118dd4

🎨 format

4215fad

builder pattern for addContextInfo

507ac66

♻️ refactor of the test: keeping only necessary testing, separated te…

7b4ec52

…sts by feature

🐛 bugfix for test, wrong global instance impacting

a01d8ac

🎨 format

d4c465b

Merge remote-tracking branch 'origin/develop' into feature/amandinehr…

1e32d65

…y/create-yaml-file-and-structure

⏪ restored "Rank N:" if error messages

6d10e3a

test

e9cd64c

Merge branch 'feature/amandinehry/create-yaml-file-and-structure' of h…

c7031bf

…ttps://github.com/amandinehry/GEOS into feature/amandinehry/create-yaml-file-and-structure

uncomment the rmoveFile() function

e07d0b7

stack trace management

785636b

Merge remote-tracking branch 'amandinehryFork/develop' into feature/a…

dd3b844

…mandinehry/create-yaml-file-and-structure

♻️ ✅ New GEOS_ERROR macros with context included + new unit macro uni…

e0bad67

…t-test + testing GEOS_ERROR

✅ ♻️ Simplifying + testing macros (GEOS_ERROR_* and GEOS_ASSERT_*) + …

ab40edc

…unit test separation for multiple EXPECT_EXIT

📝 adding macro docs

faa84fa

✨ ✅ adding error cause in unit test

dd97f0e

♻️ reordered error & throw macro to group them

d708cac

♻️ ✅ uniformized warning macros

66ab5cb

✅ 🐛 ⚡️ bugfix when callstack is empty + disable callstack for perfs

e6135b1

♻️ ✅ uniformized throw macros

589fcfe

✅ removing _CTX macros from unit test

6fc4b30

🐛 use streamed cause string to support mpi pointers formatting (not s…

77f9fcb

…upported by fmt for now)

🐛 last mistake?

5747e7f

✨ optional hdf5 output

8d8d978

MelReyCG added ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI labels Mar 4, 2026

MelReyCG added 4 commits March 4, 2026 17:07

✨reduce warning amount

98e8006

⚰️ unused capture

e715ebf

🐛wrong std::move usage

bfaca9a

✅rebaseline

8fa32e0

tjb-ltk reviewed Mar 9, 2026

View reviewed changes

MelReyCG added 7 commits March 9, 2026 16:03

💄better region/discretisation display

395d42f

🐛 Fix lacks of calling for stats recomputation at start of timestep

9310df0

♻️ remove template

6ae1a2e

✨ component formatting

899dcc9

♻️ removed getTotalFluidMass specialization (generalized total mass i…

597ae91

…nformation)

Merge remote-tracking branch 'origin/develop' into bugfix/rey/split-s…

3c33fd8

…tatistics-components

✅ rebaseline (verified: purely structural, no numerical difference)

d148974

MelReyCG added flag: no rebaseline Does not require rebaseline flag: requires rebaseline Requires rebaseline branch in integratedTests and removed flag: no rebaseline Does not require rebaseline labels Mar 11, 2026

MelReyCG added 2 commits March 12, 2026 11:09

✅ update rebaseline hash

7c017f1

Merge remote-tracking branch 'origin/develop' into bugfix/rey/split-s…

16cbaff

…tatistics-components

MelReyCG requested a review from tjb-ltk March 12, 2026 13:56

MelReyCG added 4 commits March 12, 2026 15:00

✅ update rebaseline hash

8627632

📝 missing docs

1a62df6

♻️ method should be private

610d47d

♻️ follow conventions

f047adf

MelReyCG removed ci: run integrated tests Allows to run the integrated tests in GEOS CI ci: run CUDA builds Allows to triggers (costly) CUDA jobs labels Mar 13, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Split statistics components computation & output#3836

feat: Split statistics components computation & output#3836
MelReyCG wants to merge 330 commits intodevelopfrom
bugfix/rey/split-statistics-components

MelReyCG commented Sep 26, 2025 •

edited

Loading

Uh oh!

tjb-ltk Mar 9, 2026

Uh oh!

MelReyCG Mar 9, 2026

Uh oh!

MelReyCG Mar 11, 2026

Uh oh!

tjb-ltk Mar 9, 2026

Uh oh!

MelReyCG commented Mar 11, 2026

Uh oh!

MelReyCG commented Mar 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

MelReyCG commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tjb-ltk Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

MelReyCG Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

MelReyCG Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

tjb-ltk Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

MelReyCG commented Mar 11, 2026

Uh oh!

MelReyCG commented Mar 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MelReyCG commented Sep 26, 2025 •

edited

Loading